Inside Macintosh: QuickTime /

Chapter 2 - Movie Toolbox / Movie Toolbox Reference

Functions That Modify Movie Properties / Working With Movie User Data

GetUserData

The GetUserData function returns a specified user data item.

pascal OSErr GetUserData (UserData theUserData, Handle data, 
                           OSType udType, long index);

theUserData

Specifies the user data list for this operation. You obtain this list reference by calling the GetMovieUserData, GetTrackUserData, or GetMediaUserData function (described on page 2-215, page 2-216, and page 2-217, respectively).

data

Contains a handle that is to receive the data from the specified item. The GetUserData function resizes this handle as appropriate to accommodate the item. Your application is responsible for releasing this handle when you are done with it. Set this parameter to nil if you do not want to retrieve the user data item. This can be useful if you want to verify that a user data item exists, but you do not need to work with the item's contents.

udType

Specifies the item's type value.

index

Specifies the item's index value. This parameter must specify an item in the user data list identified by the parameter theUserData.

ERROR CODES

userDataItemNotFound

-2026

Cannot locate this user data item

Memory Manager errors